+2001-11-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkaccelmap.c: Typo fixes. (#65607)
+
+ * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window):
+ Fix docs. (#65505)
+
+ * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document.
+
Wed Nov 28 18:19:12 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move
+2001-11-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkaccelmap.c: Typo fixes. (#65607)
+
+ * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window):
+ Fix docs. (#65505)
+
+ * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document.
+
Wed Nov 28 18:19:12 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move
+2001-11-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkaccelmap.c: Typo fixes. (#65607)
+
+ * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window):
+ Fix docs. (#65505)
+
+ * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document.
+
Wed Nov 28 18:19:12 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move
+2001-11-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkaccelmap.c: Typo fixes. (#65607)
+
+ * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window):
+ Fix docs. (#65505)
+
+ * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document.
+
Wed Nov 28 18:19:12 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move
+2001-11-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkaccelmap.c: Typo fixes. (#65607)
+
+ * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window):
+ Fix docs. (#65505)
+
+ * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document.
+
Wed Nov 28 18:19:12 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move
+2001-11-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkaccelmap.c: Typo fixes. (#65607)
+
+ * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window):
+ Fix docs. (#65505)
+
+ * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document.
+
Wed Nov 28 18:19:12 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move
+2001-11-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtkaccelmap.c: Typo fixes. (#65607)
+
+ * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window):
+ Fix docs. (#65505)
+
+ * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document.
+
Wed Nov 28 18:19:12 2001 Owen Taylor <otaylor@redhat.com>
* gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move
2001-11-28 Matthias Clasen <matthiasc@poet.de>
- gdk/tmpl/windows.sgml, gdk/tmpl/general.sgml,
+ * gtk/tmpl/gtkwindow.sgml: Document gtk_window_position.
+
+ * gdk/tmpl/dnd.sgml: Document GdkDragProtocol and GdkDragContext.
+
+ * gdk/tmpl/events.sgml: Document gdk_setting_get.
+
+ * gdk/tmpl/fonts.sgml: Document gdk_font_full_name_get and
+ gdk_font_full_name_free.
+
+ * gdk/tmpl/windows.sgml: Document gdk_window_register_dnd.
+
+2001-11-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gdk/tmpl/windows.sgml, gdk/tmpl/general.sgml,
gdk/tmpl/pixmaps.sgml, gdk/tmpl/drawing.sgml,
gdk/tmpl/gcs.sgml: Updates.
<!-- ##### SECTION Long_Description ##### -->
<para>
These functions provide a low level interface for drag and drop.
-GDK supports both the Xdnd and Motif drag and drop protocols transparently.
+The X backend of GDK supports both the Xdnd and Motif drag and drop protocols
+transparently, the Win32 backend supports the WM_DROPFILES protocol.
</para>
<para>
GTK+ provides a higher level abstraction based on top of these functions,
@window:
@targets:
@Returns:
-<!-- # Unused Parameters # -->
-@actions:
<!-- ##### FUNCTION gdk_drag_motion ##### -->
@possible_actions:
@time:
@Returns:
-<!-- # Unused Parameters # -->
-@action:
<!-- ##### FUNCTION gdk_drop_finish ##### -->
<!-- ##### ENUM GdkDragProtocol ##### -->
<para>
-
+Is used in #GdkDragContext to indicate the protocol according to
+which DND is done.
</para>
-@GDK_DRAG_PROTO_MOTIF:
-@GDK_DRAG_PROTO_XDND:
-@GDK_DRAG_PROTO_ROOTWIN:
-@GDK_DRAG_PROTO_NONE:
-@GDK_DRAG_PROTO_WIN32_DROPFILES:
-@GDK_DRAG_PROTO_OLE2:
-@GDK_DRAG_PROTO_LOCAL:
+@GDK_DRAG_PROTO_MOTIF: The Motif DND protocol.
+@GDK_DRAG_PROTO_XDND: The Xdnd protocol.
+@GDK_DRAG_PROTO_ROOTWIN: An extension to the Xdnd protocol for
+ unclaimed root window drops.
+@GDK_DRAG_PROTO_NONE: no protocol.
+@GDK_DRAG_PROTO_WIN32_DROPFILES: The simple WM_DROPFILES protocol.
+@GDK_DRAG_PROTO_OLE2: The complex OLE2 DND protocol (not implemented).
+@GDK_DRAG_PROTO_LOCAL: Intra-application DND.
<!-- ##### FUNCTION gdk_drag_context_unref ##### -->
<para>
<!-- ##### STRUCT GdkDragContext ##### -->
<para>
-
+A <structname>GdkDragContext</structname> holds information about a
+drag in progress. It is used on both source and destination sides.
</para>
-@parent_instance:
-@protocol:
-@is_source:
-@source_window:
-@dest_window:
-@targets:
-@actions:
-@suggested_action:
+@parent_instance:
+@protocol: the DND protocol which governs this drag.
+@is_source: %TRUE if the context is used on the source side.
+@source_window: the source of this drag.
+@dest_window: the destination window of this drag.
+@targets: a list of targets accepted on the destination.
+@actions: a bitmask of all possible actions.
+@suggested_action: the suggested action.
@action:
-@start_time:
+@start_time: a timestamp recording the start time of this drag.
+
<!-- ##### ENUM GdkDragAction ##### -->
<para>
Checks if any events are waiting to be processed.
</para>
-@Returns: TRUE if any events are pending.
+@Returns: %TRUE if any events are pending.
<!-- ##### FUNCTION gdk_event_peek ##### -->
It only checks the events that have already been moved to the GDK event queue.)
</para>
-@Returns: a copy of the first #GdkEvent on the event queue, or NULL if no
+@Returns: a copy of the first #GdkEvent on the event queue, or %NULL if no
events are in the queue. The returned #GdkEvent should be freed with
gdk_event_free().
necessary.
</para>
-@Returns: the next #GdkEvent to be processed, or NULL if no events are pending.
+@Returns: the next #GdkEvent to be processed, or %NULL if no events are pending.
The returned #GdkEvent should be freed with gdk_event_free().
</para>
@window: the #GdkWindow to wait for the events for.
-@Returns: a #GdkEventExpose if a GraphicsExpose was received, or NULL if a
+@Returns: a #GdkEventExpose if a GraphicsExpose was received, or %NULL if a
NoExpose event was received.
</para>
@event: a #GdkEvent.
-@Returns: the timestamp from @event, or #GDK_CURRENT_TIME if the event has
+@Returns: the timestamp from @event, or %GDK_CURRENT_TIME if the event has
no timestamp.
<para>
Sets whether event debugging information is output.
Note that GTK+ must be compiled with debugging enabled, i.e. using the
-'--enable-debug' configure option.
+<option>--enable-debug</option> configure option.
</para>
-@show_events: TRUE to output event debugging information.
+@show_events: %TRUE to output event debugging information.
<!-- ##### FUNCTION gdk_setting_get ##### -->
<para>
-
+Obtains a desktop-wide setting, such as the double-click time.
+</para>
+<para>
+FIXME needs a list of valid settings here, or a link to
+more information.
</para>
-@name:
-@value:
-@Returns:
+@name: the name of the setting.
+@value: location to store the value of the setting.
+@Returns: %TRUE if the value has been successfully stored.
<!-- ##### SECTION Long_Description ##### -->
<para>
-The GdkFont data type represents a font for drawing on
+The #GdkFont data type represents a font for drawing on
the screen. These functions provide support for
loading fonts, and also for determining the dimensions
of characters and strings when drawn with a particular
character set, then that font is used, otherwise if
the XLFD contains wild-cards for the registry and encoding
fields, the registry and encoding for the desired character
-set are subsituted in and a lookup is done. If a match is found
+set are substituted in and a lookup is done. If a match is found
that font is used. Otherwise, processing continues
on to the next font in the list.
</para>
<varlistentry>
<term>Wide character string</term>
<listitem><para>
- For a number of the text-measuring functions, GTK+
+ For a number of the text-measuring functions, GDK
provides a variant (such as gdk_text_width_wc()) which
takes a <type>GdkWChar *</type> instead of a
<type>gchar *</type>. The input is then taken to
<!-- ##### STRUCT GdkFont ##### -->
<para>
-The GdkFont structure represents a font or fontset. It
-contains the following public fields. A new GdkFont
+The <structname>GdkFont</structname> structure represents a font or fontset. It
+contains the following public fields. A new <structname>GdkFont</structname>
structure is returned by gdk_font_load() or gdk_fontset_load(),
and is reference counted with gdk_font_ref() and gdk_font_unref()
-
-<informaltable pgwide=1 frame="none" role="struct">
-<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
-<tbody>
-
-<row>
-<entry><structfield>type</structfield></entry>
-<entry>a value of type #GdkFontType which indicates
-whether this font is a single font or a fontset.</entry>
-</row>
-
-<row>
-<entry><structfield>ascent</structfield></entry>
-<entry>the maximum distance that the font, when drawn,
-ascends above the baseline.</entry>
-</row>
-
-<row>
-<entry><structfield>descent</structfield></entry>
-<entry>the maximum distance that the font, when drawn,
-descends below the baseline.</entry>
-</row>
-
-</tbody></tgroup></informaltable>
</para>
-@type:
-@ascent:
-@descent:
+@type: a value of type #GdkFontType which indicates
+ whether this font is a single font or a fontset.
+@ascent: the maximum distance that the font, when drawn,
+ ascends above the baseline.
+@descent: the maximum distance that the font, when drawn,
+descends below the baseline.
+
<!-- ##### ENUM GdkFontType ##### -->
<para>
Indicates the type of a font. The possible values
are currently:
-
-<informaltable pgwide=1 frame="none" role="enum">
-<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
-<tbody>
-
-<row>
-<entry>GDK_FONT_FONT</entry>
-<entry>the font is a single font.</entry>
-</row>
-
-<row>
-<entry>GDK_FONT_FONT</entry>
-<entry>the font is a fontset.</entry>
-</row>
-
-</tbody></tgroup></informaltable>
</para>
-@GDK_FONT_FONT:
-@GDK_FONT_FONTSET:
+@GDK_FONT_FONT: the font is a single font.
+@GDK_FONT_FONTSET: the font is a fontset.
+
<!-- ##### FUNCTION gdk_font_load ##### -->
<para>
</para>
<para>
-Currently, this function will always return a new
-font, however, in the future, it may be changed to
-look up the font in a cache. You should make no
-assumptions about the initial reference count.
+The font may be newly loaded or looked up the font in a cache.
+You should make no assumptions about the initial reference count.
</para>
@font_name: a XLFD describing the font to load.
-@Returns: a #GdkFont, or NULL if the font could not be loaded.
+@Returns: a #GdkFont, or %NULL if the font could not be loaded.
<!-- ##### FUNCTION gdk_fontset_load ##### -->
Loads a fontset.
</para>
<para>
-Currently this function will always return a new
-font, however, in the future, it may be changed to
-look up the font in a cache. You should make no
-assumptions about the initial reference count.
+The fontset may be newly loaded or looked up in a cache.
+You should make no assumptions about the initial reference count.
</para>
@fontset_name: a comma-separated list of XLFDs describing
the component fonts of the fontset to load.
-@Returns: a #GdkFont, or NULL if the fontset could not be loaded.
+@Returns: a #GdkFont, or %NULL if the fontset could not be loaded.
<!-- ##### FUNCTION gdk_font_from_description ##### -->
<!-- ##### FUNCTION gdk_font_ref ##### -->
<para>
-Increase the reference count of a count by one.
+Increases the reference count of a font by one.
</para>
@font: a #GdkFont
<!-- ##### FUNCTION gdk_font_unref ##### -->
<para>
-Decrease the reference count of a count by one.
+Decreases the reference count of a font by one.
If the result is zero, destroys the font.
</para>
<!-- ##### FUNCTION gdk_string_extents ##### -->
<para>
-Returns the metrics of a NULL-terminated string.
+Returns the metrics of a nul-terminated string.
</para>
@font: a #GdkFont.
-@string: the NULL-terminated string to measure.
+@string: the nul-terminated string to measure.
@lbearing: the left bearing of the string.
@rbearing: the right bearing of the string.
@width: the width of the string.
<!-- ##### FUNCTION gdk_string_width ##### -->
<para>
-Determine the width of a NULL-terminated string.
+Determines the width of a nul-terminated string.
(The distance from the origin of the string to the
point where the next string in a sequence of strings
should be drawn)
</para>
@font: a #GdkFont
-@string: the NULL-terminated string to measure
+@string: the nul-terminated string to measure
@Returns: the width of the string in pixels.
<!-- ##### FUNCTION gdk_text_width ##### -->
<para>
-Determine the width of a given string.
+Determines the width of a given string.
</para>
@font: a #GdkFont
<!-- ##### FUNCTION gdk_text_width_wc ##### -->
<para>
-Determine the width of a given wide-character string.
+Determines the width of a given wide-character string.
</para>
@font: a #GdkFont
<!-- ##### FUNCTION gdk_char_width ##### -->
<para>
-Determine the width of a given character.
+Determines the width of a given character.
</para>
@font: a #GdkFont
<!-- ##### FUNCTION gdk_char_width_wc ##### -->
<para>
-Determine the width of a given wide character. (Encoded
+Determines the width of a given wide character. (Encoded
in the wide-character encoding of the current locale).
</para>
<!-- ##### FUNCTION gdk_string_measure ##### -->
<para>
Determines the distance from the origin to the rightmost
-portion of a NULL-terminated string when drawn. This is not the
+portion of a nul-terminated string when drawn. This is not the
correct value for determining the origin of the next
portion when drawing text in multiple pieces.
See gdk_string_width().
</para>
@font: a #GdkFont
-@string: the NULL-terminated string to measure.
+@string: the nul-terminated string to measure.
@Returns: the right bearing of the string in pixels.
<!-- ##### FUNCTION gdk_string_height ##### -->
<para>
-Determines the total height of a given NULL-terminated
+Determines the total height of a given nul-terminated
string. This value is not generally useful, because you
cannot determine how this total height will be drawn in
relation to the baseline. See gdk_string_extents().
</para>
@font: a #GdkFont
-@string: the NULL-terminated string to measure.
+@string: the nul-terminated string to measure.
@Returns: the height of the string in pixels.
<!-- ##### FUNCTION gdk_font_full_name_get ##### -->
<para>
-
+Returns a comma-separated list of XLFDs for the
+fonts making up a given #GdkFont.
</para>
-@font:
-@Returns:
+@font: a #GdkFont
+@Returns: a newly-allocated string containing a list of XLFDs,
+ should be freed with gdk_font_full_name_free() when no longer needed.
<!-- ##### FUNCTION gdk_font_full_name_free ##### -->
<para>
-
+Frees a full font name obtained from gdk_font_full_name_get().
</para>
-@name:
+@name: a full font name.
<!-- ##### TYPEDEF GdkWChar ##### -->
</para>
@src: a wide character string.
-@Returns: the multi-byte string corresponding to @src, or NULL if the
+@Returns: the multi-byte string corresponding to @src, or %NULL if the
conversion failed. The returned string should be freed with g_free() when no
longer needed.
</para>
@dest: the space to place the converted wide character string into.
-@src: the multi-byte string to convert, which must be null-terminated.
+@src: the multi-byte string to convert, which must be nul-terminated.
@dest_max: the maximum number of wide characters to place in @dest.
@Returns: the number of wide characters written into @dest, or -1 if the
conversion failed.
<!-- ##### FUNCTION gdk_window_register_dnd ##### -->
<para>
-
+Registers a window as a potential drop destination.
</para>
-@window:
+@window: a #GdkWindow.
<!-- ##### FUNCTION gdk_window_begin_resize_drag ##### -->
<!-- ##### MACRO gtk_window_position ##### -->
<para>
-
+Deperecated alias for gtk_window_set_position().
</para>
* To change the accelerator during runtime programatically, use
* gtk_accel_map_change_entry().
* The accelerator path must consist of "<WINDOWTYPE>/Category1/Category2/.../Action",
- * where WINDOWTYPE should be a unique application specifc identifier, that
+ * where WINDOWTYPE should be a unique application-specific identifier, that
* corresponds to the kind of window the accelerator is being used in, e.g. "Gimp-Image",
* "Abiword-Document" or "Gnumeric-Settings".
- * The Category1/.../Action portion is most apropriately choosen by the action the
+ * The Category1/.../Action portion is most appropriately chosen by the action the
* accelerator triggers, i.e. for accelerators on menu items, choose the item's menu path,
* e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All".
* So a full valid accelerator path may look like:
* @returns: %TRUE if the accelerator could be changed, %FALSE otherwise
*
* Change the @accel_key and @accel_mods currently associated with @accel_path.
- * Due to conflicts with other accelerators, a change may not alwys be possible,
+ * Due to conflicts with other accelerators, a change may not always be possible,
* @replace indicates whether other accelerators may be deleted to resolve such
* conflicts. A change will only occur if all conflicts could be resolved (which
- * might not be the case if conflicting accelerators are locked). Succesful
+ * might not be the case if conflicting accelerators are locked). Successful
* changes are indicated by a %TRUE return value.
*/
gboolean
* Sets whether a #GtkFixed widget is created with a separate
* #GdkWindow for widget->window or not. (By default, it will be
* created with no separate #GdkWindow). This function must be called
- * while the is not realized, for instance, immediately after the
+ * while the #GtkFixed is not realized, for instance, immediately after the
* window is created.
**/
void
* Gets whether the #GtkFixed has it's own #GdkWindow.
* See gdk_fixed_set_has_window().
*
- * Return value:
+ * Return value: %TRUE if @fixed has its own window.
**/
gboolean
gtk_fixed_get_has_window (GtkFixed *fixed)
return FALSE;
}
+/**
+ * gtk_window_set_mnemonic_modifier:
+ * @window: a #GtkWindow
+ * @modifier: the modifier mask used to activate
+ * mnemonics on this window.
+ *
+ * Sets the mnemonic modifier for this window.
+ **/
void
gtk_window_set_mnemonic_modifier (GtkWindow *window,
GdkModifierType modifier)
projects / gtk4.git / commitdiff